Esx Settings Clusters Software CheckSpec

The Esx Settings Clusters Software CheckSpec schema contains properties that describe the specification to be used for running checks on the cluster before the POST /esx/settings/clusters/{cluster}/software?action=apply operation.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "commit": "string",
    "hosts": [
        "string"
    ]
}

string

commit

Optional

The minimum commit identifier of the desired software document to be used during the check operation.

This property was added in vSphere API 7.0.0.0.

if missing or null or empty the check opertion will use the latest commit to fetch the desired state document.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

array of string

hosts

Optional

The specific hosts for which checks need to be performed

This property was added in vSphere API 7.0.0.0.

if missing or null or empty checks are run for all hosts within the cluster.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

Parameter To

Esx Settings Clusters Software check$Task